home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / twview82.zip / DOCS.TXT < prev    next >
Text File  |  1991-02-04  |  17KB  |  337 lines

  1. Documentation (heh!) for the trade wars viewer programs
  2. Last revision: 1/24/91 by woody
  3.  
  4.  
  5.  
  6. Abstract:
  7. ________
  8.  
  9. The game Trade Wars is a delightful mix of economic strategy, exploration,
  10. and military conquest.  For the first two to succeed, however, requires a
  11. good working knowledge of the universe.  Unfortunately, keeping all the
  12. information about which sectors you've visited, which are ports, and which
  13. is connected to which can be a nightmare.  These two programs, "Convert" and
  14. "Examine" should help to make keeping that information straight a little
  15. easier, and increase your enjoyment of the game.
  16.  
  17. The first program, "Convert", creates a data base of explored sectors, warps
  18. for each sector, if it is a port or not, and if a port, what it is selling.
  19. The second, "Examine", allows you to look at that data base in a variety of
  20. ways, from visual graphing of the data to asking questions about nearby
  21. ports and so on.
  22.  
  23.  
  24.  
  25. What you need to run the programs:
  26. ----------------------------------
  27.  
  28. To create the data base, you need to be in a terminal program that allows
  29. ascii uploads and ascii captures.  The best situation is one that allows you
  30. to do them simultaneously, i.e. capture input while uploading a file.
  31. Second best is to have a large scrollback buffer, that allows you to take
  32. pieces out of the scrollback and append them to a file.
  33.  
  34. There are two versions of the programs, one for DOS machines and another for
  35. Macs.  (Source code available if anyone wants to port it to the Amiga or
  36. something.  Should only require minor changes to file I/O and graphics.)
  37. If you are running the DOS versions, you will need the device drivers (.BGI
  38. files) suitable for your machine.
  39.  
  40.  
  41.  
  42. HOW TO CREATE AND MAINTAIN THE ORIGINAL DATA BASE:
  43. --------------------------------------------------
  44.  
  45. First, log into the game, and invoke the computer.  Tell the computer you
  46. want the known universe report, by hitting K.  Now start an ascii download.
  47. If you have explored more than half the universe, tell the computer that you
  48. want unexplored sectors by hitting U and return.  The computer will list
  49. your unexplored sectors.  If you have explored less than half, tell the
  50. computer you want explored sectors by hitting E and return.  The computer
  51. will list your known sectors.  If you've explored a lot of sectors, there
  52. may be a [PAUSE] in the listing; just hit the space bar and go on past it.
  53. (Its okay if it shows up in your ascii download.)  When the listing is
  54. finished, turn off the download.  Your captured file must contain the line
  55. that says "You have explored the following sectors:" or "You have NOT
  56. explored the following sectors:" and at least one blank line after the
  57. sectors.  (A little more before or after is okay too.)
  58.  
  59. Now shift from your terminal program to the program "Convert".  At the first
  60. prompt, it is asking for your initial data base.  If you've already
  61. developed a data base, and are just updating it, give the name of your old
  62. base; if you don't have an existing data base, just hit a return.  Next, it
  63. will ask if it should be reading a list of explored sectors, a log of
  64. inter-warp and port information, or a list of unexplored sectors.  Choose
  65. option 1 or 3 depending on whether you hit E or U above.  Next, it will ask
  66. for your "Explored Sectors" or "Unexplored Sectors" file.  Next, it will ask
  67. you to come up with the name of a file to generate: use anything you like
  68. here, but be careful that you don't accidentally overwrite something you
  69. want to keep.  The last question the program will ask you is if you want an
  70. update on your ports: this will add a request for update for every port.
  71. The program maintains information about current trading levels for each
  72. known in the game; this will freshen that information to the current data.
  73. It probably isn't needed very often, but once in a while to update things it
  74. is useful.  (I generally use that only if I've lots of time to play around:
  75. I refresh the "interesting" ports by using an upload from the "Examine"
  76. program.)
  77.  
  78. What this step will do is create a file that you can upload to generate lots
  79. of printouts.  Essentially, what it does is create a file with I<sector
  80. number> and R<sector number> for every new sector.  The nice thing is that
  81. this will interface well with the Crai on board your ship...
  82.  
  83. Now back to Tradewars.  You are probably still in Computer mode; if not, get
  84. there.  What you want to do is upload the contents of the file you just
  85. generated with the convert program into the Crai on your ship.  If you can
  86. do that while doing an ascii download, start the download and then start the
  87. upload.  Otherwise, you may have to start the upload and then capture the
  88. results later from your scrollback buffer.  In any case, your captured file
  89. should contain all the I reports (sector nnn has warps to : xxx - yyy - zzz
  90. etc) and all the R reports (Commerce report for ...).  There will be lots of
  91. "I have no record of a port in that sector."'s: that is okay -- had to find
  92. out if there was a port there or not.  If there are a couple of ports that
  93. you are trying to keep track of, you can also call up a port report on them
  94. and store that in the downloaded file: just make sure that when you hit your
  95. R you don't just carriage return but explicitly type in the sector number.
  96.  
  97. Back to the "Convert" program.  Again, tell the program your old data file
  98. (or hit return to start fresh) and this time we are in part 2.  Tell it the
  99. name of the ascii download you just captured, and the name you want to use
  100. for your database.  The program will generate the data base.
  101.  
  102. The database is in plain text, so you can examine it yourself if you like.
  103. Information is divided into several categories.  First, are the lines
  104. ::Tradewars Data file::
  105. SpaceDock is   200
  106. if you have visited the space dock yet, or possibly SpaceDock is 0 if you
  107. haven't visited the space dock sector.
  108.  
  109. Next is a line of the form
  110. 7  <- number of notes
  111. where the integer represents how many "Notes" you've stored for the game.
  112. A note has the form
  113.    13 Don't Go Near This Sector!!!!
  114. i.e. a sector number, and a short bit of text.  You can add or delete notes
  115. in the "Examine" program, as well as display those sectors for which you've
  116. recorded notes.  
  117.  
  118. Next is a line of the form
  119. 105  <- number of Port Infos
  120. followed by lines of the form
  121.   120    3000    3280   -2530
  122. The first integer is the sector number for the port; next are the levels
  123. for the three goods "Fuel Ore", "Organics", and "Equipment".  A positive
  124. number means that the port is selling the stuff, and a negative number means
  125. the port is buying up to that much of the stuff.  (Remember that the larger
  126. the magnitude of the number, the better the price you get -- ports are more
  127. willing to stretch when the numbers are higher!)  The sectors are in no
  128. special order (actually, in order of appearance from the logs over time) but
  129. there must be as many lines as specified in the <- number of Port Infos...
  130.  
  131. Next is a line of the form
  132. Sector data starts here...
  133. followed by lines of the form
  134.  
  135.     1  6    2    3    4    5    6    7  8     2
  136.  
  137. <sector> <number of warps> <warp1> ... <warpn> <port code> <etc code>
  138. Here, for example, is a report for sector 1: it has six warps, to positions
  139. 2 through 7, a port code of 8 (which actually corresponds to class 0)
  140. and an "etc" code of 2.  A "Port Code" corresponds to -1, if the sector
  141. is not a port, 0 through 7 based upon a three bit representation of selling
  142. or buying (for example, sector 120 is selling Ore, selling Organics, and
  143. buying Equipment, so its port code would be 1 * 1 + 1 * 2 + 0 * 4 = 3; don't
  144. worry about it, the program handles figuring out port codes and so on).  The
  145. "etc" code tells about various pieces of information, again depending on bit
  146. representation: currently the codes in use are
  147.   NoteExists = 1;
  148.   IsPort     = 2;
  149.   Stardock   = 128;
  150. but others will probably follow.  (Note that the Stardock is also a port; so
  151. its etc code is 128 + 2 = 130; if a random port had a note attached, its
  152. code would be 2 + 1 = 3.)
  153.  
  154. There is no particular limit to the number of sector warp information lines;
  155. in particular, if you are merging information with someone else, you have to
  156. be careful when it comes to adding together the port and note info (you must
  157. have only ONE line in the "port infos" or "note info" area for a sector, and
  158. the number must match with the header number, but you can just concatenate
  159. the warp sectors.  The worst that will happen is that it won't be able to
  160. find an attached note or port info, which will confuse the program but not
  161. fatally.  This makes a good way for a corporation to gain a real edge: some
  162. of the group can be doing the exploring, they can merge their information
  163. together with other members of the corp, and then members with the
  164. CargoTrans or the like can go out, and do some Combat Trading...
  165.  
  166.  
  167.  
  168. HOW TO USE THE DATA BASE VIEWER
  169. --- -- --- --- ---- ---- ------
  170.  
  171. Its pretty well impossible to draw a decent map with all 1000 sectors, so
  172. the data base viewer doesn't try to do that.  Run "Examine", and tell it the
  173. name of your data base.  You will be presented with a list of options.  In
  174. version 0.8, you get to choose from the following list:
  175.  
  176. Choose one of 
  177.   <A>dd note
  178.   <D>ispersion of sectors
  179.   <E>dit data base
  180.   Closest place to buy <F>ighters, shields, and holds
  181.   Note <I>nformation
  182.   <L>ength of path between two sectors
  183.   <M>ajor Space Lane information
  184.   <N>earest port
  185.   <P>aired ports
  186.   <Q>uit
  187.   Nearest <S>ectors
  188.   <T>ranswarp menu
  189.   Nearest <U>nexplored sectors
  190.   <V>iew space in graphic format
  191.   e<X>cise note (delete it)
  192.  
  193. Here is what the commands will do:
  194.   <A>dd note
  195.   Note <I>nformation
  196.   e<X>cise note (delete it)
  197.  
  198. These manage the notes that you may have stored on your universe.  Typical
  199. notes might be "enemy base here!", "great trading spot", "Fedspace", or
  200. whatever.  Option "A" will add a note to a sector, option "X" will delete a
  201. note from a sector, and option "I" will present you with a list of the notes
  202. you've made, sorted by distance from a current sector.
  203.  
  204.   <D>ispersion of sectors
  205.  
  206. This will display how many sectors there are at a specified distance from
  207. your current sector.  You can tell you are in the boonies when there are
  208. lots of sectors at large distances, and not too many at close distances...
  209.  
  210.   <E>dit data base
  211.  
  212. This allows you to go in an mark a sector as unexplored, create or destroy a
  213. port, and define the location of the star dock.  You might want to do the
  214. former if you think something has gone wrong with your data; the next
  215. because someone has either shot up a star port or built one.  You might need
  216. to tell the data base where the star dock is located if your sysop has
  217. redefined the name of the port where stardock is located; the program looks
  218. for "StarGate Alpha" -- and if its not there, or been moved, the program
  219. won't find it and you will have to tell it directly.
  220.  
  221.   Closest place to buy <F>ighters, shields, and holds
  222.  
  223. Invoke this option, and you will be asked for your current sector.  The
  224. computer will then display the path from that sector to any place it knows of
  225. to buy fighters: if the only class 0 port you know is Terra, that is the
  226. only one it will display, but if you know the others, it will display a
  227. shortest path to that sector.
  228.  
  229.   <L>ength of path between two sectors
  230.  
  231. You specify two sectors, and it will tell you the shortest way it knows of
  232. to get between those two sectors.  Note that this may NOT be the actual
  233. shortest path, if there are sectors you have not yet explored that might
  234. give you a better route.  It gives you the shortest path YOU'VE EXPLORED
  235. between those two sectors.
  236.  
  237.   <N>earest port
  238.   Nearest <S>ectors
  239.   Nearest <U>nexplored sectors
  240.  
  241. These displays will give you information about what is close to your current
  242. position.  Information displayed includes if the sector has been explored,
  243. any notes, if its a port, its status (SSB for example, means selling Ore,
  244. selling Organics, and buying Equipment) and levels of production.  If you
  245. ask for the "Nearest Port" report, only ports are listed.  I find the
  246. "Nearest Unexplored sectors" report VERY useful for exploration purposes: I
  247. can just head toward the nearest unexplored sector easily this way.
  248.  
  249.   <M>ajor Space Lane information
  250.  
  251. This report is supposed to show you the sectors that are the major space
  252. lanes.  Take this with a grain of salt.  First of all, if you haven't
  253. explored the sectors on the major space lanes, it will use not the true
  254. shortest route but the shortest route it knows of.  Secondly, because the
  255. algorithm the Martins are using for shortest path is apparently not the same
  256. as the one I'm using, (I'm trying to communicate with them to find out what
  257. they do in the program) if there is more than one way to get from Space Dock
  258. to the class 0 ports, or from one class 0 port to another, the data
  259. presented might not be right.  Hopefully this will be nailed down in a later
  260. version.
  261.  
  262.   <P>aired ports
  263.  
  264. This is one of my favorites.  What it does is go through the data base and
  265. find ports that are adjacent (i.e. you can warp between them using normal
  266. space in one turn) and are compatible (i.e. at port A you can buy a good
  267. that is sold at port B, and you can sell a good that is bought at port B).
  268. You can be selective (greedy) and only specify ports that are compatible in
  269. the very profitable Organic-Equipment trade, or ask for all compatible
  270. pairs.  The program offers you the opportunity to have the results sent to a
  271. text file, which you can then print later (if you can't run the program
  272. simultaneously with your terminal emulator, you can get hard copy of the
  273. "hot sectors") and you can have the results sent to a text file that are
  274. compatible for upload (i.e. part 2 of the "Convert" program so you can keep
  275. an eye on trading levels at these critical ports).  Displayed to the screen
  276. is an integer "factor" -- this number is based upon levels of goods
  277. available in the critical trades, and will give a rough estimate of how good
  278. a deal you are going to get.
  279.  
  280.   <T>ranswarp menu
  281.  
  282. This drops down to a submenu that deals with locations of deployed fighters
  283. and using a transwarp drive.  Most submenu items are pretty obvious: you
  284. specify where you have deployed fighters, or tell the data base that some
  285. #%!%@$ has shot up your deployed fighters, or list the places the data base
  286. knows you've deployed your fighters.  The only thing that needs mentioning
  287. is the shortest route submenu item: you specify where you are, and where you
  288. want to go.  It figures out, based upon where your fighters are located, the
  289. fastest route to get there (using a transwarp jump and then normal
  290. autopilot).  It may say to transwarp to your current sector -- that just
  291. means the shortest route lies through normal space.
  292.  
  293.   <V>iew space in graphic format
  294.  
  295. Viewing the data will attempt a graphic display on your screen of space:
  296. you tell it about how many rows across and columns up and down of sectors to
  297. use (maximums are given in the program: hit a return, and you get a default
  298. value that is about 3/4 of maximum); you tell it the base sector you want in
  299. the center of the screen (has to be a sector you've visited!); and you tell
  300. it how large a radius to display (all sectors it is aware of no more than
  301. that distance away from your base sector).  It will try to display the
  302. collection of warps that make up space.  Ordinary, visited sectors are
  303. displayed as circles, ports as rectangles.  (Unexplored sectors just have
  304. their numbers floating in space, and if you have color are in yellow.)
  305. Lines between sectors means there is a warp connecting one with the other.
  306. Dashed lines means that you don't know if the warp is two way or not: if one
  307. end of the sector is unexplored, you will have a dashed line.  If both ends
  308. are explored, then the warp really is one way!  (Try graphing around the
  309. StarDock and around the class 0 ports.)  Don't try to graph too many sectors
  310. at once: the screen gets too busy, and you won't be able to tell what
  311. connects to what.
  312.  
  313.  
  314. FEEDBACK
  315. ________
  316.  
  317.  
  318. Best place for info is 415-376-1554; leave mail to number 1.
  319.  
  320.  
  321.  
  322. ACKNOWLEDGEMENTS
  323. ________________
  324.  
  325. Thanks, of course, to the Martins for such a great game!
  326.  
  327.  
  328. COPYRIGHT AND LICENSING STUFF
  329. -----------------------------
  330.  
  331. Copyright 1991 by Robert Weaver.  All Rights Reserved.  You may not
  332. distribute this for any fee beyond reasonable costs of distribution.
  333. Permission is granted to distribute this document and the related
  334. executables and source code provided this notice is preserved, and anyone
  335. you give the executable has the ability to obtain this documentation and the
  336. accompanying source.
  337.